GET api/v1/delivery/eddm?postalCodes[0]={postalCodes[0]}&postalCodes[1]={postalCodes[1]}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
postalCodes

Collection of string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of EddmPopulation
NameDescriptionTypeAdditional information
PostalCode

string

None.

ResidentialCount

integer

None.

BusinessCount

integer

None.

TotalCount

integer

None.

Routes

Collection of EddmRoutePopulation

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PostalCode": "sample string 1",
    "ResidentialCount": 2,
    "BusinessCount": 3,
    "TotalCount": 4,
    "Routes": [
      {
        "CarrierRouteID": "sample string 1",
        "ResidentialCount": 2,
        "BusinessCount": 3,
        "TotalCount": 4
      },
      {
        "CarrierRouteID": "sample string 1",
        "ResidentialCount": 2,
        "BusinessCount": 3,
        "TotalCount": 4
      }
    ]
  },
  {
    "PostalCode": "sample string 1",
    "ResidentialCount": 2,
    "BusinessCount": 3,
    "TotalCount": 4,
    "Routes": [
      {
        "CarrierRouteID": "sample string 1",
        "ResidentialCount": 2,
        "BusinessCount": 3,
        "TotalCount": 4
      },
      {
        "CarrierRouteID": "sample string 1",
        "ResidentialCount": 2,
        "BusinessCount": 3,
        "TotalCount": 4
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfEddmPopulation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <EddmPopulation>
    <BusinessCount>3</BusinessCount>
    <PostalCode>sample string 1</PostalCode>
    <ResidentialCount>2</ResidentialCount>
    <Routes>
      <EddmRoutePopulation>
        <BusinessCount>3</BusinessCount>
        <CarrierRouteID>sample string 1</CarrierRouteID>
        <ResidentialCount>2</ResidentialCount>
        <TotalCount>4</TotalCount>
      </EddmRoutePopulation>
      <EddmRoutePopulation>
        <BusinessCount>3</BusinessCount>
        <CarrierRouteID>sample string 1</CarrierRouteID>
        <ResidentialCount>2</ResidentialCount>
        <TotalCount>4</TotalCount>
      </EddmRoutePopulation>
    </Routes>
    <TotalCount>4</TotalCount>
  </EddmPopulation>
  <EddmPopulation>
    <BusinessCount>3</BusinessCount>
    <PostalCode>sample string 1</PostalCode>
    <ResidentialCount>2</ResidentialCount>
    <Routes>
      <EddmRoutePopulation>
        <BusinessCount>3</BusinessCount>
        <CarrierRouteID>sample string 1</CarrierRouteID>
        <ResidentialCount>2</ResidentialCount>
        <TotalCount>4</TotalCount>
      </EddmRoutePopulation>
      <EddmRoutePopulation>
        <BusinessCount>3</BusinessCount>
        <CarrierRouteID>sample string 1</CarrierRouteID>
        <ResidentialCount>2</ResidentialCount>
        <TotalCount>4</TotalCount>
      </EddmRoutePopulation>
    </Routes>
    <TotalCount>4</TotalCount>
  </EddmPopulation>
</ArrayOfEddmPopulation>

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.